home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / comm / auhtml16.zip / AUTOHTML.DOC next >
Text File  |  1996-07-13  |  6KB  |  174 lines
  1.                                AUTOHTML
  2.  
  3.                               Version 1.6
  4.  
  5.  
  6.  
  7. Overview:
  8.  
  9. AUTOHTML creates a multi-page web site from text source files in the 
  10. current directory. The first page is always called TOC.HTML and is a 
  11. table of contents linking to the other pages. 
  12.  
  13. A page is created for each source file. If the defaults are selected, 
  14. a separate table of contents file will be created for each page, with 
  15. the name TOCxxxxx.HTM where xxxxx is the last five characters of the 
  16. source file name.
  17.  
  18. The title for the first page is received from the command line as a 
  19. parameter supplied to AUTOHTML.EXE. Enclose this text within speech 
  20. marks, or only the first word will be picked up! Each entry in the 
  21. first page (TOC.HTML) is derived from a single text line in a file 
  22. with the same name as the source file, but with the extension .TIT 
  23. (short for title). If a TIT file can not be located in the current 
  24. directory, the source file name is used. This title is also used to 
  25. head the source web page and any table of contents page for that 
  26. source file. 
  27.  
  28. Links are automaticaly created whenever a word refers to another item 
  29. heading in any of the source pages. Multiple links to the same topic 
  30. within a section can be supressed with the "duplicate links=no" 
  31. setting in autohtml.ini.
  32.  
  33. Source Files:
  34.  
  35. Source files follow the KNB format; Simply these are comprised of an 
  36. item heading line prefixed by an asterisk, thus: 
  37.  
  38. *This is an item heading
  39.  
  40. followed by any number of lines of text which comprise that item's 
  41. data.
  42.  
  43. To force a link to a multiple word heading, replace spaces with under 
  44. bars (_) within the item data, for example:
  45.  
  46. This example will link with Greater_London.
  47.  
  48.  
  49.  
  50. Command Line:
  51.  
  52.         AUTOHTML "Title For First Page"
  53.  
  54.  
  55. Automatic Links:
  56.  
  57. Automatic links will only ever be made to the current page or to the 
  58. first source file, in alphabetical order, containing a reference to 
  59. the item. You can force other files to be linked first by so naming 
  60. them as to be alphabetically earlier. Eg; a file 'AAA.TXT' will be 
  61. scanned before a file called 'BAA.TXT'. For example. If the title 
  62. PARIS occurs in the current page and in another page, a link will be 
  63. made to the current page reference for PARIS. If however, the title 
  64. PARIS occurs in three pages, but not in the current page, then a link 
  65. will be made to the reference PARIS in the page named first.
  66.  
  67. Table Of Contents:
  68.  
  69. The format of each table of contents is either a list, or a table. 
  70. Defined by toc table=yes or toc table=no in autohtml.ini. If a tabular 
  71. format table of contents is required, the number of columns, border 
  72. and cell spacing information is read from the autohtml.ini file. 
  73. Otherwise these parameters are ignored.
  74.  
  75.  
  76. Limitations:
  77.  
  78. AUTOHTML will not create graphical systems. It is designed to carry 
  79. out the donkey work of linking multiple machine-readable text files 
  80. into a fully linked web site. If you want in-line graphics, forms, 
  81. links to other URLs and so on then you will have to add these your 
  82. self.
  83.  
  84.  
  85. AUTOHTML.INI:
  86.  
  87. AUTOHTML acceses a configuration file (autohtml.ini) in the directory 
  88. where autohtml.exe resides. This configuration file may be amended to 
  89. change the format of the created web site.
  90.  
  91. [preferences]
  92. separate table of contents=yes  (Table of contents separate to main 
  93.                                  data)
  94. main title font=1               (Font 1-6 for main title)
  95. sub title font=2                (Font 1-6 for subsequent title lines)
  96. toc font=3                      (Font to display table of contents 
  97.                                  entries)
  98. source=knb                      (Source file extension)
  99. toc table=yes                   (Use table format for each table of 
  100.                                  contents) 
  101. columns=3                       (Number of table columns) 
  102. width=100                       (Table width as a % of screen width) 
  103. cellspacing=2                   (Table cell spacing) 
  104. border=10                       (Table border) 
  105.  
  106. [item]
  107. title font=2                    (Font 1-6 for item titles)
  108. data font=4                     (Font 1-6 to display item data)
  109. title italic=yes                (Item titles Italic yes or no)
  110. title bold=yes                  (Item titles Bold yes or no)
  111. duplicate links=no              (Whether subsequent links to the same
  112.                                  topic should be made within a 
  113.                                  paragraph)
  114.  
  115. [ignore]
  116. ; Any words in this section will not be linked
  117. A
  118. IN
  119. OF
  120. THE
  121.  
  122. Compatability:
  123.  
  124. AUTOHTML has been tested with NCSA Mosaic, Microsoft Internext 
  125. Explorer and Netscape.
  126.  
  127.  
  128. Frequently Asked Questions:
  129.  
  130. Q. I only have one source file, autohtml creates three HTML files. How do 
  131.    I get around this?
  132.  
  133. A. Autohtml always creates a primary table of contents HTML filed 
  134.    called TOC.HTM. This provides a link to all the source files. If 
  135.    you only have one source file, then you can delete the TOC.HTM 
  136.    file. If you have separate table of contents=yes set in the 
  137.    autohtml.ini configuration file, then two HTML files will be 
  138.    created for each source file. The name of one file will commence 
  139.    TOC and this is the table of contents for the other data file. 
  140.    Rename this table of contents file to TOC.HTM and your web site is 
  141.    done.
  142.  
  143. Q. Autohtml doesn't create any HTML files. What's wrong?
  144.  
  145. A. Autohtml searches the current directory for files with an extension 
  146.    matching the source= setting in the configuration file 
  147.    autohtml.ini. Probably you have an incorrect extension set in the 
  148.    configuration file. Remember, the extension in the source= line 
  149.    does not include a period, eg:
  150.  
  151.                 source=knb
  152.  
  153.  
  154.  
  155. Q. When I try to view the HTML files in Mosaic, Mosaic crashes. Help!
  156.  
  157. A. Mosaic is a rather fragile HTML viewer. Try splitting the source 
  158.    files down into more smaller files. 
  159.  
  160.  
  161.  
  162.  
  163. (c)1996 Servile Software
  164.  
  165. Servile Software
  166. 5 Longcroft Close
  167. Basingstoke
  168. Hampshire
  169. RG21 8XG
  170.  
  171. WWW     http://www.pins.co.uk/upages/probertm
  172. EMAIL   probertm@pins.co.uk
  173.  
  174.